IK Blur Image


IK Blur Image Image Number, Radius
IK Blur Image Image Number, Radius, Mode

Description

This command will blur an image with a specified radius and mode. If the Mode parameter is not specified, BLUR_AVERAGE will be used by default. This command does not work on render targets. If the image is a render target, the program will return an error. If Radius <= 0 then this command will be ignored.

A list of available modes are:
Constant nameConstantDescription
BLUR_AVERAGE1Average blur. Each pixel will have the same weight in the resulting pixel. Also known as box blur.
This blur is the fastest one of the three modes. It uses a horizontal and a vertical pass for optimal performance on a CPU. Each pass loops through each pixel only once.
BLUR_GAUSSIANIIR2Uses the gaussian distribution with the Infinite Impulse Response technique. The speed for this algorithm is radius-independent, and so it works best on large radiuses.
This mode also uses a horizontal and a vertical pass for optimal performance on a CPU. Each pass loops through each pixel twice (once forwards and once backwards). Due to the nature of the algorithm the speed of this mode becomes inferior to the BLUR_GAUSSIANFIR mode for small radiuses.
BLUR_GAUSSIANFIR3Uses the gaussian distribution with the Finite Impulse Response technique. The speed for this algorithm is radius-dependant, but is faster than the IIR technique when the radius is small.
This mode also uses a horizontal and a vertical pass for optimal performance on a CPU. Each pass loops through each pixel about 2*Radius times. So at a certain point it is more efficient to use the BLUR_GAUSSIANIIR mode.

Parameters

Image NumberIntegerThe ID of the image.
RadiusIntegerThe radius of the blur.
ModeIntegerSets the blur mode.


Index